Entity Door
Door is the Entity definition for a door.
Subclass of Usable.
Functions
| GetSounds () | GetSounds returns the name of the sound file to use for the door. |
| GetSensorRange () | GetSensorRange returns the opening sensor range for the door. |
| GetChanceUnlock () | GetChanceUnlock returns the unlock chance for a locked door. |
| GetTimeOpen () | GetTimeOpen returns the time taken for a door to open. |
| IsLaserDoor () | IsLaserDoor returns true if the door is a laser-bar door. |
| IsAutoclose () | IsAutoclose returns true if the door automatically closes. |
| CanBreak () | CanBreak returns true if the door can break. |
| IsSensorOpen () | IsSensorOpen returns true if the door can be opened by sensor. |
| IsTrapDoor () | IsTrapDoor returns true if the door is trapped. |
| IsOpen () | IsOpen returns true if the door is currently opened. |
| IsOpenOutwards () | IsOpenOutwards returns true if the door opens outwards. |
| IsLocked () | IsLocked returns true if the door is currently locked. |
| IsLockable () | IsLockable returns true if the door is lockable. |
Fields
| isDoor | Indicates that the object is a door. |
Functions
- GetSounds ()
-
GetSounds returns the name of the sound file to use for the door.
Returns:
-
A string indicating the sound to use for the door.
- GetSensorRange ()
-
GetSensorRange returns the opening sensor range for the door.
Returns:
-
A numeric value indicating the door sensor range.
- GetChanceUnlock ()
-
GetChanceUnlock returns the unlock chance for a locked door.
Returns:
-
An integer indicating the door unlock chance.
- GetTimeOpen ()
-
GetTimeOpen returns the time taken for a door to open.
Returns:
-
An integer indicating the door opening time.
- IsLaserDoor ()
-
IsLaserDoor returns true if the door is a laser-bar door.
Returns:
-
A boolean indicating a laser-bar door.
- IsAutoclose ()
-
IsAutoclose returns true if the door automatically closes.
Returns:
-
A boolean indicating if the door automatically closes.
- CanBreak ()
-
CanBreak returns true if the door can break.
Returns:
-
A boolean indicating if the door can break.
- IsSensorOpen ()
-
IsSensorOpen returns true if the door can be opened by sensor.
Returns:
-
A boolean indicating if the door can be opened by sensor.
- IsTrapDoor ()
-
IsTrapDoor returns true if the door is trapped.
Returns:
-
A boolean indicating if the door is trapped.
- IsOpen ()
-
IsOpen returns true if the door is currently opened.
Returns:
-
A boolean indicating if the door is opened.
- IsOpenOutwards ()
-
IsOpenOutwards returns true if the door opens outwards.
Returns:
-
A boolean indicating if the door opens outwards.
- IsLocked ()
-
IsLocked returns true if the door is currently locked.
Returns:
-
A boolean indicating if the door is locked.
- IsLockable ()
-
IsLockable returns true if the door is lockable.
Returns:
-
A boolean indicating if the door is lockable.